-
Notifications
You must be signed in to change notification settings - Fork 40
/
IDbSet`1.xml
302 lines (302 loc) · 16.7 KB
/
IDbSet`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<Type Name="IDbSet<TEntity>" FullName="System.Data.Entity.IDbSet<TEntity>">
<TypeSignature Language="C#" Value="public interface IDbSet<TEntity> : System.Collections.Generic.IEnumerable<TEntity>, System.Linq.IQueryable<TEntity> where TEntity : class" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDbSet`1<class TEntity> implements class System.Collections.Generic.IEnumerable`1<!TEntity>, class System.Collections.IEnumerable, class System.Linq.IQueryable, class System.Linq.IQueryable`1<!TEntity>" />
<TypeSignature Language="DocId" Value="T:System.Data.Entity.IDbSet`1" />
<TypeSignature Language="VB.NET" Value="Public Interface IDbSet(Of TEntity)
Implements IEnumerable(Of TEntity), IQueryable(Of TEntity)" />
<TypeSignature Language="F#" Value="type IDbSet<'Entity (requires 'Entity : null)> = interface
 interface IQueryable<'Entity (requires 'Entity : null)>
 interface seq<'Entity (requires 'Entity : null)>
 interface IQueryable
 interface IEnumerable" />
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TEntity">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<T></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<TEntity></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Linq.IQueryable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Linq.IQueryable<TEntity></InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix", Justification="Name is intentional")</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="entity-framework-4.3.1;entity-framework-5.0.0">
<AttributeName>System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", Justification="Casing is intentional")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="TEntity"> The type that defines the set. </typeparam>
<summary>
An <see cref="T:System.Data.Entity.IDbSet`1" /> represents the collection of all entities in the context, or that
can be queried from the database, of a given type. <see cref="T:System.Data.Entity.DbSet`1" /> is a concrete
implementation of IDbSet.
</summary>
<remarks>
<see cref="T:System.Data.Entity.IDbSet`1" /> was originally intended to allow creation of test doubles (mocks or
fakes) for <see cref="T:System.Data.Entity.DbSet`1" />. However, this approach has issues in that adding new members
to an interface breaks existing code that already implements the interface without the new members.
Therefore, starting with EF6, no new members will be added to this interface and it is recommended
that <see cref="T:System.Data.Entity.DbSet`1" /> be used as the base class for test doubles.
</remarks>
</Docs>
<Members>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public TEntity Add (TEntity entity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TEntity Add(!TEntity entity) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.IDbSet`1.Add(`0)" />
<MemberSignature Language="VB.NET" Value="Public Function Add (entity As TEntity) As TEntity" />
<MemberSignature Language="F#" Value="abstract member Add : 'Entity -> 'Entity" Usage="iDbSet.Add entity" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entity" Type="TEntity" />
</Parameters>
<Docs>
<param name="entity"> The entity to add. </param>
<summary>
Adds the given entity to the context underlying the set in the Added state such that it will
be inserted into the database when SaveChanges is called.
</summary>
<returns> The entity. </returns>
<remarks>
Note that entities that are already in the context in some other state will have their state set
to Added. Add is a no-op if the entity is already in the context in the Added state.
</remarks>
</Docs>
</Member>
<Member MemberName="Attach">
<MemberSignature Language="C#" Value="public TEntity Attach (TEntity entity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TEntity Attach(!TEntity entity) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.IDbSet`1.Attach(`0)" />
<MemberSignature Language="VB.NET" Value="Public Function Attach (entity As TEntity) As TEntity" />
<MemberSignature Language="F#" Value="abstract member Attach : 'Entity -> 'Entity" Usage="iDbSet.Attach entity" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entity" Type="TEntity" />
</Parameters>
<Docs>
<param name="entity"> The entity to attach. </param>
<summary>
Attaches the given entity to the context underlying the set. That is, the entity is placed
into the context in the Unchanged state, just as if it had been read from the database.
</summary>
<returns> The entity. </returns>
<remarks>
Attach is used to repopulate a context with an entity that is known to already exist in the database.
SaveChanges will therefore not attempt to insert an attached entity into the database because
it is assumed to already be there.
Note that entities that are already in the context in some other state will have their state set
to Unchanged. Attach is a no-op if the entity is already in the context in the Unchanged state.
</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public TEntity Create ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TEntity Create() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.IDbSet`1.Create" />
<MemberSignature Language="VB.NET" Value="Public Function Create () As TEntity" />
<MemberSignature Language="F#" Value="abstract member Create : unit -> 'Entity" Usage="iDbSet.Create " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TEntity</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a new instance of an entity for the type of this set.
Note that this instance is NOT added or attached to the set.
The instance returned will be a proxy if the underlying context is configured to create
proxies and the entity type meets the requirements for creating a proxy.
</summary>
<returns> The entity instance, which may be a proxy. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create<TDerivedEntity>">
<MemberSignature Language="C#" Value="public TDerivedEntity Create<TDerivedEntity> () where TDerivedEntity : class, TEntity;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !!TDerivedEntity Create<class (!TEntity) TDerivedEntity>() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.IDbSet`1.Create``1" />
<MemberSignature Language="VB.NET" Value="Public Function Create(Of TDerivedEntity As {Class, TEntity}) () As TDerivedEntity" />
<MemberSignature Language="F#" Value="abstract member Create : unit -> 'DerivedEntity" Usage="iDbSet.Create " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TDerivedEntity</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TDerivedEntity">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
<BaseTypeName>TEntity</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="TDerivedEntity"> The type of entity to create. </typeparam>
<summary>
Creates a new instance of an entity for the type of this set or for a type derived
from the type of this set.
Note that this instance is NOT added or attached to the set.
The instance returned will be a proxy if the underlying context is configured to create
proxies and the entity type meets the requirements for creating a proxy.
</summary>
<returns> The entity instance, which may be a proxy. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Find">
<MemberSignature Language="C#" Value="public TEntity Find (params object[] keyValues);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TEntity Find(object[] keyValues) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.IDbSet`1.Find(System.Object[])" />
<MemberSignature Language="VB.NET" Value="Public Function Find (ParamArray keyValues As Object()) As TEntity" />
<MemberSignature Language="F#" Value="abstract member Find : obj[] -> 'Entity" Usage="iDbSet.Find keyValues" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyValues" Type="System.Object[]">
<Attributes>
<Attribute FrameworkAlternate="entity-framework-4.3.1">
<AttributeName>System.ParamArray</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="keyValues"> The values of the primary key for the entity to be found. </param>
<summary>
Finds an entity with the given primary key values.
If an entity with the given primary key values exists in the context, then it is
returned immediately without making a request to the store. Otherwise, a request
is made to the store for an entity with the given primary key values and this entity,
if found, is attached to the context and returned. If no entity is found in the
context or the store, then null is returned.
</summary>
<returns> The entity found, or null. </returns>
<remarks>
The ordering of composite key values is as defined in the EDM, which is in turn as defined in
the designer, by the Code First fluent API, or by the DataMember attribute.
</remarks>
</Docs>
</Member>
<Member MemberName="Local">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.ObservableCollection<TEntity> Local { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ObservableCollection`1<!TEntity> Local" />
<MemberSignature Language="DocId" Value="P:System.Data.Entity.IDbSet`1.Local" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Local As ObservableCollection(Of TEntity)" />
<MemberSignature Language="F#" Value="member this.Local : System.Collections.ObjectModel.ObservableCollection<'Entity (requires 'Entity : null)>" Usage="System.Data.Entity.IDbSet<'Entity (requires 'Entity : null)>.Local" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ObservableCollection<TEntity></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets an <see cref="T:System.Collections.ObjectModel.ObservableCollection`1" /> that represents a local view of all Added, Unchanged,
and Modified entities in this set. This local view will stay in sync as entities are added or
removed from the context. Likewise, entities added to or removed from the local view will automatically
be added to or removed from the context.
</summary>
<value> The local view. </value>
<remarks>
This property can be used for data binding by populating the set with data, for example by using the Load
extension method, and then binding to the local data through this property. For WPF bind to this property
directly. For Windows Forms bind to the result of calling ToBindingList on this property
</remarks>
</Docs>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public TEntity Remove (TEntity entity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TEntity Remove(!TEntity entity) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.IDbSet`1.Remove(`0)" />
<MemberSignature Language="VB.NET" Value="Public Function Remove (entity As TEntity) As TEntity" />
<MemberSignature Language="F#" Value="abstract member Remove : 'Entity -> 'Entity" Usage="iDbSet.Remove entity" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entity" Type="TEntity" />
</Parameters>
<Docs>
<param name="entity"> The entity to remove. </param>
<summary>
Marks the given entity as Deleted such that it will be deleted from the database when SaveChanges
is called. Note that the entity must exist in the context in some other state before this method
is called.
</summary>
<returns> The entity. </returns>
<remarks>
Note that if the entity exists in the context in the Added state, then this method
will cause it to be detached from the context. This is because an Added entity is assumed not to
exist in the database such that trying to delete it does not make sense.
</remarks>
</Docs>
</Member>
</Members>
</Type>